/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.exception;

import kameleon.plugin.PlugInInfo;

/**
 * Exception thrown when an invalid plug-in is encountered.
 * 
 * @author 		Schnell Michaël
 * @version		1.0
 */
public class InvalidPlugInException extends KameleonException {

	/**
	 * Needed to serialize this class.
	 * 
	 * @see		java.io.Serializable
	 */
	private static final long serialVersionUID = 9079944637077881462L ;
	
	/**
	 * Default error message.
	 */
	private static final String DEFAULT_ERROR_MESSAGE 
		= "The plug-in is not valid." ;//$NON-NLS-1$
	
	/**
	 * Formatted error message.
	 */
	private static final String FORMATTED_ERROR_MESSAGE 
		= "'%s' is not a valid plug-in." ;//$NON-NLS-1$

	/**
	 * Builds a {@code InvalidPlugInException} with a default error message.
	 */
	public InvalidPlugInException() {
		this(DEFAULT_ERROR_MESSAGE) ;
	}// InvalidPlugInException()
	
	/**
	 * Builds a {@code InvalidPlugInException} with a formatted error message.
	 * 
	 * @param 	info
	 * 			information about the faulty plug-in
	 */
	public InvalidPlugInException(PlugInInfo info) {
		super(String.format(FORMATTED_ERROR_MESSAGE, info.getJarName())) ;
	}// InvalidPlugInException(PlugInInfo)
	
	/**
	 * Builds a {@code InvalidPlugInException} with a formatted error message
	 * and a cause.
	 * 
	 * @param 	info
	 * 			information about the faulty plug-in
	 * 
	 * @param 	cause 
	 * 			instance of {@code Throwable} which caused this exception to be thrown
	 */
	public InvalidPlugInException(PlugInInfo info, Throwable cause) {
		super(String.format(FORMATTED_ERROR_MESSAGE, info.getJarName()), cause) ;
	}// InvalidPlugInException(PlugInInfo)
	
	/**
	 * Builds a {@code FileReadingException} with the given message.
	 * 
	 * @param 	message
	 * 			detailed message about the exception
	 */
	public InvalidPlugInException(String message) {
		super(message) ;
	}// InvalidPlugInException(String)

}// class InvalidPlugInException